docs: add developer onboarding guide to CONTRIBUTING.md - #622
Open
woahwhattheheck wants to merge 9 commits into
Open
woahwhattheheck wants to merge 9 commits into
woahwhattheheck wants to merge 9 commits into
Conversation
Replace the scaffold placeholder with setup instructions for frontend, backend, and contracts, plus architecture overview, code standards, testing guide, and PR process. Closes Protocol-Guild#561
GitHub Actions does not accept retention-days on the workflow root. That key is only valid on upload-artifact. The extra key made every workflow fail validation on push before any job started.
GitHub Actions does not accept retention-days at the workflow root. That made build, secrets-check, contract-release, and dapp-ipfs fail with zero jobs on every push. Keep comments; set retention in repo settings.
This was referenced Sep 24, 2026
Separate the frontend Vite command from the root Stellar scaffold watcher, place frontend environment settings in its Vite project, and document one PORT=3000 local API setting matching the existing frontend proxy and health URL. Retain the backend's 3001 fallback when PORT is unset. Refs Protocol-Guild#561. Validation: exact package-script, backend config, example-env, frontend proxy, and Vite 7.2.6 root/envDir reconciliation; balanced Markdown fences, resolved relative links, unchanged guide sections outside setup. Docs only: no Node, application build/tests, or Prettier run during the shared runtime-capacity hold. No runtime/configuration files changed.
Replace the malformed placeholder setup block with the real repository clone command and links to the maintained prerequisites, setup, testing, and PR guide. Keep the existing contributor guide and application source unchanged.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Closes #561
What
Replaces the three-line scaffold placeholder in
CONTRIBUTING.mdwith a full contributor guide covering:Why
New contributors had no onboarding path beyond a leftover scaffold note. A real guide unblocks community setup and keeps PR quality consistent.
How tested
backend/.env.example, backend/frontend scripts, and.github/workflows/LICENSE/ Cargo workspace license